<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Open SCA: PropertySet_impl Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="customdoxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.onetek.net"><img alt="Logo" src="openscaLogo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Open SCA
   &#160;<span id="projectnumber">Version 0.6.0</span>
   </div>
   <div id="projectbrief">Open SCA</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_property_set__impl.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_property_set__impl-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PropertySet_impl Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The PropertySet class defines configure and query operations to access component properties/attributes.  
 <a href="class_property_set__impl.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_resource__impl_8h_source.html">Resource_impl.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PropertySet_impl:</div>
<div class="dyncontent">
<div class="center"><img src="class_property_set__impl__inherit__graph.png" border="0" usemap="#_property_set__impl_inherit__map" alt="Inheritance graph"/></div>
<map name="_property_set__impl_inherit__map" id="_property_set__impl_inherit__map">
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1e152070740b45863f24b52a2d2d719f"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_property_set__impl.html#a1e152070740b45863f24b52a2d2d719f">~PropertySet_impl</a> ()</td></tr>
<tr class="separator:a1e152070740b45863f24b52a2d2d719f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af816c250675d87a1030c9ab1e916ba17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_property_set__impl.html#af816c250675d87a1030c9ab1e916ba17">PropertySet_impl</a> ()</td></tr>
<tr class="memdesc:af816c250675d87a1030c9ab1e916ba17"><td class="mdescLeft">&#160;</td><td class="mdescRight">The PropertySet class defines configure and query operations to access component properties/attributes.  <a href="#af816c250675d87a1030c9ab1e916ba17">More...</a><br /></td></tr>
<tr class="separator:af816c250675d87a1030c9ab1e916ba17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7e9bdb132efe45d4d44e25382710888"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_property_set__impl.html#af7e9bdb132efe45d4d44e25382710888">configure</a> (const CF::Properties &amp;configProperties)  throw (	    CF::PropertySet::PartialConfiguration,	    CF::PropertySet::InvalidConfiguration,	    CORBA::SystemException)</td></tr>
<tr class="memdesc:af7e9bdb132efe45d4d44e25382710888"><td class="mdescLeft">&#160;</td><td class="mdescRight">The configure operation allows id/value pair configuration properties to be assigned to components implementing this interface.  <a href="#af7e9bdb132efe45d4d44e25382710888">More...</a><br /></td></tr>
<tr class="separator:af7e9bdb132efe45d4d44e25382710888"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad521c0d9f0daafd715d0ac96414bdf61"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_property_set__impl.html#ad521c0d9f0daafd715d0ac96414bdf61">query</a> (CF::Properties &amp;configProperties)  throw (	    CF::UnknownProperties,	    CORBA::SystemException)</td></tr>
<tr class="memdesc:ad521c0d9f0daafd715d0ac96414bdf61"><td class="mdescLeft">&#160;</td><td class="mdescRight">The query operation allows a component to be queried to retrieve its properties.  <a href="#ad521c0d9f0daafd715d0ac96414bdf61">More...</a><br /></td></tr>
<tr class="separator:ad521c0d9f0daafd715d0ac96414bdf61"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a3597982da05843b34a3268b52d2e1191"><td class="memItemLeft" align="right" valign="top">CF::DataType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_property_set__impl.html#a3597982da05843b34a3268b52d2e1191">getProperty</a> (CORBA::String_var <a class="el" href="_device_manager__server_8cpp.html#afd0d68c6d31ff249f3ae8662162663c3">id</a>)</td></tr>
<tr class="separator:a3597982da05843b34a3268b52d2e1191"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a5d02e97ffb53c3a6adee08fa5d87d3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_property_set__impl.html#a7a5d02e97ffb53c3a6adee08fa5d87d3">validateForConfig</a> (CF::Properties props, CF::Properties &amp;validProps, CF::Properties &amp;invalidProps)</td></tr>
<tr class="separator:a7a5d02e97ffb53c3a6adee08fa5d87d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78ac0aedfc545bb91bc7b7b36313ece8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_property_set__impl.html#a78ac0aedfc545bb91bc7b7b36313ece8">validateForQuery</a> (CF::Properties props, CF::Properties &amp;validProps, CF::Properties &amp;invalidProps)</td></tr>
<tr class="separator:a78ac0aedfc545bb91bc7b7b36313ece8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a899718a8c1a122514c4ac6d729181bd3"><td class="memItemLeft" align="right" valign="top">CF::Properties&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_property_set__impl.html#a899718a8c1a122514c4ac6d729181bd3">propSet</a></td></tr>
<tr class="separator:a899718a8c1a122514c4ac6d729181bd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc99fc8cffc343be08d9cbf045a50a4b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_property_set__impl.html#acc99fc8cffc343be08d9cbf045a50a4b">init_config</a></td></tr>
<tr class="separator:acc99fc8cffc343be08d9cbf045a50a4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The PropertySet class defines configure and query operations to access component properties/attributes. </p>

<p>Definition at line <a class="el" href="_resource__impl_8h_source.html#l00032">32</a> of file <a class="el" href="_resource__impl_8h_source.html">Resource_impl.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a1e152070740b45863f24b52a2d2d719f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="class_property_set__impl.html">PropertySet_impl</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_resource__impl_8cpp_source.html#l00121">121</a> of file <a class="el" href="_resource__impl_8cpp_source.html">Resource_impl.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="af816c250675d87a1030c9ab1e916ba17"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_property_set__impl.html">PropertySet_impl</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The PropertySet class defines configure and query operations to access component properties/attributes. </p>

<p>Definition at line <a class="el" href="_resource__impl_8cpp_source.html#l00117">117</a> of file <a class="el" href="_resource__impl_8cpp_source.html">Resource_impl.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af7e9bdb132efe45d4d44e25382710888"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void configure </td>
          <td>(</td>
          <td class="paramtype">const CF::Properties &amp;&#160;</td>
          <td class="paramname"><em>configProperties</em></td><td>)</td>
          <td></td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2">	    CF::PropertySet::PartialConfiguration,</td>
        </tr>
        <tr>
          <td align="right"></td><td></td><td colspan="2">	    CF::PropertySet::InvalidConfiguration,</td>
        </tr>
        <tr>
          <td align="right"></td><td></td><td colspan="2">CORBA::SystemException</td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The configure operation allows id/value pair configuration properties to be assigned to components implementing this interface. </p>
<p>The configure operation shall assign values to the properties as indicated in the input configProperties parameter. Valid properties for the configure operation shall at a minimum be the configure readwrite and writeonly properties referenced in the component’s SPD.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">configProperties</td><td>Properties need configured. </td></tr>
  </table>
  </dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">The</td><td>configure operation shall raise a PartialConfiguration exception when some configuration properties were successfully set and some configuration properties were not successfully set.</td></tr>
  </table>
  </dd>
</dl>
<p>The configure operation shall raise an InvalidConfiguration exception when a configuration error occurs and no configuration properties were successfully set. </p>

<p>Definition at line <a class="el" href="_resource__impl_8cpp_source.html#l00126">126</a> of file <a class="el" href="_resource__impl_8cpp_source.html">Resource_impl.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a3597982da05843b34a3268b52d2e1191"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">CF::DataType getProperty </td>
          <td>(</td>
          <td class="paramtype">CORBA::String_var&#160;</td>
          <td class="paramname"><em>id</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_resource__impl_8cpp_source.html#l00188">188</a> of file <a class="el" href="_resource__impl_8cpp_source.html">Resource_impl.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ad521c0d9f0daafd715d0ac96414bdf61"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void query </td>
          <td>(</td>
          <td class="paramtype">CF::Properties &amp;&#160;</td>
          <td class="paramname"><em>configProperties</em></td><td>)</td>
          <td></td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2">	    CF::UnknownProperties,</td>
        </tr>
        <tr>
          <td align="right"></td><td></td><td colspan="2">CORBA::SystemException</td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The query operation allows a component to be queried to retrieve its properties. </p>
<p>The query operation shall return all component properties when the inout parameter configProperties is zero size. The query operation shall return only those id/value pairs specified in the configProperties parameter if the parameter is not zero size. Valid properties for the query operation shall be all configure properties (simple properties whose kind element’s kindtype attribute is “configure”) whose mode attribute is “readwrite” or “readonly” and any allocation properties with an action value of "external" as referenced in the component's SPD.</p>
<p>param[inout] Properties need queried. </p><dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">The</td><td>query operation shall raise the CF UnknownProperties exception when one or more properties being requested are not known by the component. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented in <a class="el" href="class_device__servant.html#ad521c0d9f0daafd715d0ac96414bdf61">Device_servant</a>, and <a class="el" href="class_application__impl.html#ad521c0d9f0daafd715d0ac96414bdf61">Application_impl</a>.</p>

<p>Definition at line <a class="el" href="_resource__impl_8cpp_source.html#l00202">202</a> of file <a class="el" href="_resource__impl_8cpp_source.html">Resource_impl.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a7a5d02e97ffb53c3a6adee08fa5d87d3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void validateForConfig </td>
          <td>(</td>
          <td class="paramtype">CF::Properties&#160;</td>
          <td class="paramname"><em>props</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">CF::Properties &amp;&#160;</td>
          <td class="paramname"><em>validProps</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">CF::Properties &amp;&#160;</td>
          <td class="paramname"><em>invalidProps</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_resource__impl_8cpp_source.html#l00261">261</a> of file <a class="el" href="_resource__impl_8cpp_source.html">Resource_impl.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a78ac0aedfc545bb91bc7b7b36313ece8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void validateForQuery </td>
          <td>(</td>
          <td class="paramtype">CF::Properties&#160;</td>
          <td class="paramname"><em>props</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">CF::Properties &amp;&#160;</td>
          <td class="paramname"><em>validProps</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">CF::Properties &amp;&#160;</td>
          <td class="paramname"><em>invalidProps</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_resource__impl_8cpp_source.html#l00292">292</a> of file <a class="el" href="_resource__impl_8cpp_source.html">Resource_impl.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="acc99fc8cffc343be08d9cbf045a50a4b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool init_config</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_resource__impl_8h_source.html#l00093">93</a> of file <a class="el" href="_resource__impl_8h_source.html">Resource_impl.h</a>.</p>

</div>
</div>
<a class="anchor" id="a899718a8c1a122514c4ac6d729181bd3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">CF::Properties propSet</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_resource__impl_8h_source.html#l00092">92</a> of file <a class="el" href="_resource__impl_8h_source.html">Resource_impl.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>frameworks/libCF_Utils/include/<a class="el" href="_resource__impl_8h_source.html">Resource_impl.h</a></li>
<li>frameworks/libCF_Utils/src/<a class="el" href="_resource__impl_8cpp_source.html">Resource_impl.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_property_set__impl.html">PropertySet_impl</a></li>
    <li class="footer">Generated on Fri Jul 12 2019 14:31:54 for
    <a href="http://www.onetek.net">
    <img class="footer" src="openscaLogo.png" height="31" alt="openSCA"/></a>
    </li>
  </ul>
</div>
</body>
</html>
